Update RMM docs to use NVIDIA theme#2443
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe PR updates documentation configuration to use ChangesDocumentation Theme and Infrastructure Migration
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
dependencies.yaml (1)
349-350: ⚡ Quick winConsider pinning nvidia-sphinx-theme version.
Installing
nvidia-sphinx-themewithout a version constraint could lead to unexpected breaking changes if the theme is updated. Consider adding a version range for stability.📌 Suggested version constraint
- pip: - - nvidia-sphinx-theme + - nvidia-sphinx-theme>=1.0,<2.0🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@dependencies.yaml` around lines 349 - 350, The pip dependency entry for nvidia-sphinx-theme is unpinned; update the dependencies.yaml pip list entry for nvidia-sphinx-theme to include an explicit version constraint (either a fixed version like ==X.Y.Z or a safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent accidental breaking changes; locate the nvidia-sphinx-theme item in the pip list and replace the bare name with the chosen versioned specifier and run dependency resolution to verify compatibility.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@dependencies.yaml`:
- Around line 349-350: The pip dependency entry for nvidia-sphinx-theme is
unpinned; update the dependencies.yaml pip list entry for nvidia-sphinx-theme to
include an explicit version constraint (either a fixed version like ==X.Y.Z or a
safe range like >=X.Y,<X+1.0 or ~=X.Y) to prevent accidental breaking changes;
locate the nvidia-sphinx-theme item in the pip list and replace the bare name
with the chosen versioned specifier and run dependency resolution to verify
compatibility.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5e3a806b-1bb6-4190-8c0a-d864b8d0ad5e
📒 Files selected for processing (9)
conda/environments/all_cuda-129_arch-aarch64.yamlconda/environments/all_cuda-129_arch-x86_64.yamlconda/environments/all_cuda-132_arch-aarch64.yamlconda/environments/all_cuda-132_arch-x86_64.yamlcpp/doxygen/Doxyfilecpp/doxygen/header.htmldependencies.yamldocs/conf.pydocs/cpp/memory_resources/index.md
💤 Files with no reviewable changes (1)
- cpp/doxygen/header.html
josephine-wolf-oberholtzer
left a comment
There was a problem hiding this comment.
Sphinx changes LGTM. Can't comment on the rest.
Removed instructions to browse memory resource implementations.
|
/merge |
Updates the cuDF docs to use the NVIDIA Sphinx theme, following the same direction as rapidsai/rmm#2443. This removes the local RAPIDS custom CSS/JS injection from the Sphinx and Doxygen docs configuration, switches the cuDF and dask-cuDF Sphinx configs to `nvidia_sphinx_theme`, and updates docs dependencies from `pydata-sphinx-theme` to `nvidia-sphinx-theme`. ## Validation - Parsed edited Sphinx config files with `ast.parse`. - Parsed `dependencies.yaml` and generated conda environment YAML files with `yaml.safe_load`. - Ran commit-time pre-commit hooks, including `RAPIDS dependency file generator`. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - Vyas Ramasubramani (https://github.com/vyasr) URL: #23035
## Description - uses `NVIDIA RMM` for the documentation project and landing-page branding - removes the inactive Twitter/X icon - uses `NVIDIA RMM Documentation` consistently for HTML, LaTeX, man, and Texinfo output - retains the GitHub icon and NVIDIA theme defaults Follow-up to rapidsai/build-planning#300 and #2443. ## Validation - Doxygen generation passes - strict Sphinx HTML build passes with `-n -W --keep-going` - targeted pre-commit hooks pass ## Checklist - [x] I am familiar with the [Contributing Guidelines](https://github.com/rapidsai/rmm/blob/HEAD/CONTRIBUTING.md). - [x] New or existing tests cover these changes. - [x] The documentation is up to date with these changes.
Description
Updates the RMM docs to use the NVIDIA Sphinx theme, removes the local RAPIDS custom CSS/JS includes that are injected by docs post-processing, disables Doxygen dot graph generation to avoid the Graphviz/GTK/Wayland dependency chain, and adds context to the C++ memory resources landing page.
Checklist